Merges tutor code back into the rascal project by jurgenvinju · Pull Request #2001 · usethesource/rascal

jurgenvinju · 2024-07-16T16:42:18Z

used git-filter-repo to remove all unnecessary scaffolding from rascal-tutor, and rename its source folder to
src/org/rascalmpl/tutor.

# cloned rascal-tutor from scratch
git clone git@github.com:usethesource/rascal-tutor.git
# this removed everthing from the project's history except this path:
git-filter-repo --path src/lang/rascal/tutor  
# this put the code back into the original folder in the rascal project (src/org/rascalmpl/tutor)
git-filter-repo --path src/lang/rascal/tutor --path-rename src/lang/rascal/tutor:/src/org/rascalmpl/tutor/lang/rascal/tutor 
# remove all the tags locally
git tag --delete $(git tag --list)
# remove all the branches locally (except the main branch and possibly a current branch marked with *)
git branch remove $(git branch --list | grep -v "^\*" | grep -v "main")
# then switch to the rascal project
cd ../rascal
git checkout -b adopt-tutor
# add the clean project as a remote
git remote add -f tutor-baby ../rascal-tutor
# merge the code into this branch
git merge tutor-baby/main --no-ff --allow-unrelated-histories

The goal is to:

move the selenium dependent code to rascal-maven-plugin as a service
load this service via dependency injection into the tutor repl executor
make sure the tutor's tests are executed by the rascal project as well
make sure the rascal-maven-plugin can work without a dependency on the old rascal-tutor project
remove the rascal-tutor from the website
make sure the rascal-tutor documentation is added to the Rascal documentation
upgrade the tutor repl wrapper for the changes made to the REPL interfaces in the jline3 PR

…to work in different project

…call-outs in source text and itemized lists with unicode inverted circled digits

…explicit pathConfig that is passed to the create function

…t of the Tutor REPL

…hot is taken

… documentation construction

…of large canvasses

This reverts commit f3134df.

…anup of external processes

…ded the classes we need to shutdown the external processes

…nfiguration of the evaluator

… their bodies because those communicate how to use functions and what to expect of the output

jurgenvinju · 2024-07-16T19:48:35Z

See usethesource/rascal-maven-plugin#22 for the use of these changes in the rascal-maven-plugin project, which now depends on selenium to make the screenshots.

jurgenvinju · 2024-07-16T19:56:49Z

See usethesource/rascal-website#58 for the addition of the tutor's documentation to the website.

codecov · 2025-01-29T14:50:04Z

Codecov Report

Attention: Patch coverage is 0% with 165 lines in your changes missing coverage. Please review.

Project coverage is 50%. Comparing base (27c2891) to head (39a03ee).
Report is 150 commits behind head on main.

Files with missing lines	Patch %	Lines
...r/lang/rascal/tutor/repl/TutorCommandExecutor.java	0%	113 Missing ⚠️
...rascal/tutor/repl/TutorCommandExecutorCreator.java	0%	26 Missing ⚠️
...tutor/lang/rascal/tutor/repl/TutorIDEServices.java	0%	13 Missing ⚠️
...pl/tutor/lang/rascal/tutor/questions/Feedback.java	0%	10 Missing ⚠️
...g/rascalmpl/repl/rascal/RascalInterpreterREPL.java	0%	3 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##              main   #2001    +/-   ##
========================================
  Coverage       49%     50%            
+ Complexity    6251    6248     -3     
========================================
  Files          675     677     +2     
  Lines        59270   58995   -275     
  Branches      8642    8617    -25     
========================================
- Hits         29579   29575     -4     
+ Misses       27458   27185   -273     
- Partials      2233    2235     +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Merges tutor code back into the rascal project

jurgenvinju added 30 commits October 9, 2022 11:57

moved code back to where it belongs

e79998a

relocated classes to their right package

d7ff0eb

relocated classes to their right package

12b1cdb

fixed broken image links with empty alt tags, and changed test setup …

f1d9dde

…to work in different project

callout feature: added a line post-processor stage which can replace …

14c6e1c

…call-outs in source text and itemized lists with unicode inverted circled digits

fixed callouts in multiline comments and fixed multidigit callouts

08bc514

improved regex for callouts

a171a36

forgot to add classloader to REPL evaluator that depends only on the …

8f9b0f2

…explicit pathConfig that is passed to the create function

added screenshot feature to tutor

ee75016

added screenshot feature for Content results that appear on the outpu…

4caef41

…t of the Tutor REPL

improvement of screenshot feature

534f28f

organized imports

1f9f3e0

better highlighting for function headers and aliases

27d6e7c

added a sleep to make sure the charts are rendered before the screens…

94800a5

…hot is taken

fixed reference to library index files

192adf2

added dummy empty IDEServices just in case some module uses it during…

bd4598f

… documentation construction

switched from firefox to chrome to avoid crashing during screenshots …

d1d59e3

…of large canvasses

added ignore feature using pcfg.ignores

4c4a8c2

better structure for the webdriver

f3134df

Revert "better structure for the webdriver"

8b47a9f

This reverts commit f3134df.

make tutor also run correctly without screenshot feature, and add cle…

b3c9ec9

…anup of external processes

guarded cleanup against null references

0ae2bcb

fixed initialization bug in version without screenshots

3502ee4

fixes #7

250b953

added more opportunity to ignore

042a6c9

fixed broken links

76017d3

moved back to finalizer because the clean up thread has already unloa…

7f60643

…ded the classes we need to shutdown the external processes

fixed compiler errors

85f39aa

running tutor outside of rascal project requires some fixes in the co…

273355f

…nfiguration of the evaluator

sorting out the test functions in a module and documenting those with…

b4ebb37

… their bodies because those communicate how to use functions and what to expect of the output

jurgenvinju added 10 commits May 13, 2024 14:34

fixed compilation problems due to evolved API around IRascalMonitor

c4bbae4

enabled progress reports during indexing

5fc948a

merged code of tutor into rascal project at src/org/rascalmpl/tutor

ae50b8d

check tutor code as well

830bac8

package rename

b5f4eec

screenshot feature is not injected dynamically

d714323

removed unused code

4380329

added tutor to Source folders

3e84649

fixed javaClass reference

c22ef4e

screenshotter can throw IOExceptions

a1aa469

jurgenvinju requested review from DavyLandman and PaulKlint July 16, 2024 18:48

jurgenvinju self-assigned this Jul 16, 2024

jurgenvinju added 5 commits July 16, 2024 21:15

simplified extension

b5579e6

simplified

29ecff6

fixed compilation error

279b995

cleanup

e0d34eb

fixed HEAD tag

224dcb9

jurgenvinju marked this pull request as ready for review July 16, 2024 19:47

jurgenvinju and others added 5 commits January 27, 2025 18:54

Merge branch 'main' into adopt-tutor-code

6f4f55e

removed dead Java wrapper around question compiler

1c5d39b

Merge branch 'main' into adopt-tutor-code

691a31b

Fixed namespace location

c9f6ac0

Rewrote repl integration for the tutor

39a03ee

jurgenvinju merged commit c53a238 into main Feb 4, 2025
5 of 7 checks passed

jurgenvinju deleted the adopt-tutor-code branch February 4, 2025 12:15

jurgenvinju added a commit that referenced this pull request May 10, 2025

Merge pull request #2001 from usethesource/adopt-tutor-code

c059c86

Merges tutor code back into the rascal project

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merges tutor code back into the rascal project#2001

Merges tutor code back into the rascal project#2001
jurgenvinju merged 130 commits intomainfrom
adopt-tutor-code

jurgenvinju commented Jul 16, 2024 •

edited

Loading

Uh oh!

jurgenvinju commented Jul 16, 2024

Uh oh!

jurgenvinju commented Jul 16, 2024

Uh oh!

codecov bot commented Jan 29, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

jurgenvinju commented Jul 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jurgenvinju commented Jul 16, 2024

Uh oh!

jurgenvinju commented Jul 16, 2024

Uh oh!

codecov bot commented Jan 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jurgenvinju commented Jul 16, 2024 •

edited

Loading

codecov bot commented Jan 29, 2025 •

edited

Loading